Package oracle.AWXML

Contains classes that define a logical object model and instantiate it in an analytic workspace.

See:
Description

Interface Summary

DerivedMeasureInput

Interface specifying that conforming objects can be used as input to calculations for derived measures.

Class Summary

Aggregation	A CalculationSpecification that specifies the rules for aggregating data over a hierarchical dimension.
AggregationArgument	An abstract class that specifies actions that affect an aggregation operation over a hierarchy.
AggregationDefinition	A SolveDefinition that specifies aggregation instructions for an AggregationSolve.
AggregationHierarchySpecification	An Aggregation that specifies the rules for aggregating data for members of a hierarchy of a dimension.
AggregationOperator	An abstract class that specifies the operator used in an Aggregation.
AggregationSolve	A Solve that specifies the Measure objects that are the source and target measures of an aggregation operation and an AggregationDefinition that has the instructions for the aggregation operation.
Allocation	Specifies the rules for allocating data to a measure for members of a hierarchy of a dimension.
AllocationArgument	An object that contains one or more parameters that affect an allocation operation.
AllocationDefinition	A SolveDefinition that specifies allocation instructions for an AllocationSolve.
AllocationHierarchySpecification	An Allocation that specifies the rules for allocating data for members of a hierarchy of a dimension.
AllocationOperator	An object that contains an OperatorType for an allocation operation; the operator type specifies the method of allocation of data over a hierarchy.
AllocationSolve	A Solve that allocates data down one or more dimension hierarchies from a source measure to a target measure in an analytic workspace.
Attribute	A BaseObject that represents an attribute of a dimension member.
AttributeProjection	Associates an Attribute for a Dimension to a Hierarchy or a Level of the Dimension.
AttributeSourceExpression	Maps a column of a relational database to an Attribute or AttributeProjection.
AW	Represents an analytic workspace.
AWConnection	Establishes a JDBC connection to an Oracle Database instance and a context within the database for processing actions specified by Analytic Workspace Java API objects.
AWDatabaseNull	Represents a null object in the analytic workspace.
AWExceptionMessageResources	Contains locale-specific objects related to the oracle.AWXML package.
AWExceptionMessageResources_de	Contains locale-specific objects related to the oracle.AWXML package.
AWExceptionMessageResources_es	Contains locale-specific objects related to the oracle.AWXML package.
AWExceptionMessageResources_fr	Contains locale-specific objects related to the oracle.AWXML package.
AWExceptionMessageResources_it	Contains locale-specific objects related to the oracle.AWXML package.
AWExceptionMessageResources_ja	Contains locale-specific objects related to the oracle.AWXML package.
AWExceptionMessageResources_ko	Contains locale-specific objects related to the oracle.AWXML package.
AWExceptionMessageResources_pt_BR	Contains locale-specific objects related to the oracle.AWXML package.
AWExceptionMessageResources_zh_CN	Contains locale-specific objects related to the oracle.AWXML package.
AWExceptionMessageResources_zh_TW	Contains locale-specific objects related to the oracle.AWXML package.
AWHandlerBase	Parses XML string representations of Analytic Workspace API objects and restores the objects in memory.
AWObject	A BaseObject that supports attributes and that can be mapped to a relational source.
BaseObject	An abstract class that specifies an object in the Analytic Workspace Java API object model.
BaseOperator	An object that contains an OperatorType for an aggregation operation; the operator value of the OperatorType specifies the method of aggregation of data over a hierarchy.
CalculatedMember	An abstract class specifying a dimension member that results from a calculation.
CalculatedMemberRef	A CalculatedMember reference in a Model.
CalculationSpecification	An abstract class that specifies how to aggregate data over a dimension.
ConfigurationParameters	An object that contains one or more parameters that affect an aggregation operation.
Cube	An AWObject that specifies an OLAP cube.
CubeDimensionSourceExpression	A RestrictedSourceExpression that maps a Dimension, or one or more Level objects of a Dimension, for a Cube to columns in a relational table.
CubeDimRef	A Dimension reference in a Cube.
CubeMapGroup	A MappingGroup that specifies data source mapping expressions for a Cube.
DerivedMeasure	A Measure the values of which result from mathematical operations or data transformations on values of other Measure objects.
Dimension	An AWObject that specifies a dimension.
DimensionKeySourceExpression	A column mapping for a Dimension, a Hierarchy, or a Level.
DimensionMapGroup	A MappingGroup that specifies data source mapping expressions for a Dimension.
DimensionMemberExpression	A set of dimension members for a DimensionMemberSelection or a PreComputeClause.
DimensionMemberSelection	A selection of members of a Dimension.
ExtendedProperty	This class is not used by Analytic Workspace Java API application developers.
ExternalSourceExpression	The column mapping for an AWObject.
ForecastArgument	An argument to a ForecastDefinition.
ForecastArgumentValue	The value portion of a keyword/value pair for a ForecastArgument.
ForecastDefinition	A SolveDefinition that specifies forecasting instructions for a ForecastSolve.
ForeCastKeyWord	The keyword portion of a keyword/value pair for a ForecastArgument.
ForecastSolve	A Solve that specifies a forecast operation in an analytic workspace.
HierarchicalParentSourceExpression	An ExternalSourceExpression that maps a relational column of child values to a column of parent values in a hierarchy of a dimension.
Hierarchy	An AWObject that specifies a hierarchy of a dimension.
HierarchyLevelAssociation	Associates a Level with a Hierarchy.
Index	Creates an index for an Attribute, which enables a query to execute more quickly.
Level	A MemberSelection whose members share the same level within a hierarchy of a dimension.
MappingGroup	An abstract class that represents a group of expressions that map data sources to target analytic workspace objects.
Measure	A BaseObject that represents an OLAP measure.
MeasureFolder	A collection of Measure objects.
MeasureSourceExpression	A RestrictedSourceExpression that maps one or more relational columns to a Measure.
MemberSelection	An AWObject that defines a set of dimension members within the owning Dimension.
Model	Represents an OLAP model, which is a set of interrelated OLAP DML equations that result in a set of dimension members.
ModelRef	A reference to a Model in an AggregationDefinition.
OlapMeasure	A Measure that has values that result from certain OLAP operations, such as a lead, lag, or moving average operation.
OlapMeasureInput	An object that provides an input for the OLAP operation of an OlapMeasure.
Operator	An operator that an analytic workspace uses in calculating the values of a DerivedMeasure that are specified by the DerivedMeasureInput objects associated with the Operator.
OperatorType	An object that represents a method of aggregation or allocation.
Parameter	An object that specifies an action that affects an aggregation or allocation operation over a hierarchy.
PermanentCalculatedMember	A CalculatedMember that is stored permanently in the analytic workspace.
PreComputeClause	A set of dimension members in an AggregationHierarchySpecification for which data should be precalculated with the OLAP DML AGGREGATE command.
RestrictedSourceExpression	An abstract class that restricts the rows of data within the source columns for a measure, dimension, or dimension reference in a cube.
SessionCalculatedMember	A CalculatedMember that is stored during the current session and discarded when the workspace is closed.
Solve	An abstract class that represents a calculation on multidimensional data.
SolveDefDimRef	A dimension reference for an AggregationDefinition.
SolveDefinition	The instructions for performing a Solve.
SolveGroup	A collection of Solve objects.
SourceColumn	Specifies a column in the relational database for an ExternalSourceExpression.
WhereClause	A SQL WHERE clause that specifies the rows of data to load from a source column into a Measure or a Dimension.

Exception Summary

AWConnectionException	Indicates that the program is unable to establish a JDBC connection to the Oracle Database instance.
AWException	Indicates that an exception has occurred in an Analytic Workspace Java API operation.
AWExpressCommandException	Indicates that an OLAP DML command returned an error condition.
AWExpressObjectNotFound	Indicates that the analytic workspace cannot find a specified object.
AWFunctionNotSupported	Indicates that the analytic workspace does not support the requested function.
AWMemberExistsException	Indicates that the analytic workspace is unable to create a dimension member because that member already exists.
AWObjectExistsException	Indicates that the analytic workspace is unable to create an object because that object already exists.
ObjectNotValidException	Indicates that an object is not a valid Analytic Workspace Java API object.

Package oracle.AWXML Description

Contains classes that define a logical object model and instantiate it in an analytic workspace.

With the object model, you can build a logical model in memory that describes your data as a cube, maps relational columns to the cube, and defines calculations on the data of the cube.

Object Hierarchy

The object model defines an object hierarchy. The top-level objects of the model are: Cube, Dimension, and SolveGroup. The top-level objects are owned by a relational schema. All other objects are owned by another object in the model.

For more information on the logical model for OLAP and standard form analytic workspaces, see the Oracle OLAP Application Developer's Guide.

AWXML Base Classes

The AWXML package contains three base classes:

• AWConnection, which establishes a JDBC connection and initializes OLAP processing within the Database.
• AWHandlerBase, which parses stored XML and restores it as Java objects in memory.
• BaseObject, which defines the object model.

All of the other classes in the AWXML package are subclasses of BaseObject.

AWXML Action Model for Java Applications

In the AWXML package, all of the classes in the object model have action methods. An action method reads the object definition in memory and performs an action on it in an analytic workspace. Action methods are distinguished by having having an initial capital letter.

Java applications use action methods for interactive processing. The action methods Create, Delete, and Alter affect the metadata for objects in an analytic workspace; they do not affect data. For example, the Create method of a Cube defines the measures and dimensionality of the Cube, but it does not load data or populate the dimensions. An Alter method affects the text attributes of an object. For instance, you could use an Alter method to update the long and short descriptions of a dimension.

Attach and Detach actions affect the analytic workspace itself. A Commit action saves your changes permanently in the database.

The AWXML package does not provide an action method for loading data or executing calculations in an analytic workspace. For this you must use the BuildDatabase class in the AWAction package. BuildDatabase loads data from the mapped data sources and performs any predefined calculations on the data. Calculations (specified by Solve objects) are ordered within a SolveGroup for a particular analytic workspace. The Execute method of a BuildDatabase cause the solves (aggregations, allocations, and forecasts) to be executed in order.

AWXML Action Model for XML-based Applications

The object model includes methods for storing the object descriptions as XML. If you are using the Analytic Workspace API to create XML-based applications that execute through PL/SQL, then you must use the AWAction package to apply action objects to the object descriptions. The AWXML action methods are not meaningful within a sequential, batch-processing environment.